home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / elispman.lha / elispman / elisp-27 (.txt) < prev    next >
GNU Info File  |  1993-06-01  |  50KB  |  928 lines

  1. This is Info file elisp, produced by Makeinfo-1.55 from the input file
  2. elisp.texi.
  3.    This is edition 2.0 of the GNU Emacs Lisp Reference Manual, for
  4. Emacs Version 19.
  5.    Published by the Free Software Foundation, 675 Massachusetts Avenue,
  6. Cambridge, MA 02139 USA
  7.    Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11.    Permission is granted to copy and distribute modified versions of
  12. this manual under the conditions for verbatim copying, provided that
  13. the entire resulting derived work is distributed under the terms of a
  14. permission notice identical to this one.
  15.    Permission is granted to copy and distribute translations of this
  16. manual into another language, under the above conditions for modified
  17. versions, except that this permission notice may be stated in a
  18. translation approved by the Foundation.
  19. File: elisp,  Node: Sentinels,  Next: Transaction Queues,  Prev: Output from Processes,  Up: Processes
  20. Sentinels: Detecting Process Status Changes
  21. ===========================================
  22.    A "process sentinel" is a function that is called whenever the
  23. associated process changes status for any reason, including signals
  24. (whether sent by Emacs or caused by the process's own actions) that
  25. terminate, stop, or continue the process.  The process sentinel is also
  26. called if the process exits.  The sentinel receives two arguments: the
  27. process for which the event occurred, and a string describing the type
  28. of event.
  29.    The string describing the event looks like one of the following:
  30.    * `"finished\n"'.
  31.    * `"exited abnormally with code EXITCODE\n"'.
  32.    * `"NAME-OF-SIGNAL\n"'.
  33.    * `"NAME-OF-SIGNAL (core dumped)\n"'.
  34.    A sentinel runs only while Emacs is waiting (e.g., for terminal
  35. input, or for time to elapse, or for process output).  This avoids the
  36. timing errors that could result from running them at random places in
  37. the middle of other Lisp programs.  You may explicitly cause Emacs to
  38. wait, so that sentinels will run, by calling `sit-for', `sleep-for' or
  39. `accept-process-output' (*note Accepting Output::.).  Emacs is also
  40. waiting when the command loop is reading input.
  41.    Quitting is normally inhibited within a sentinel--otherwise, the
  42. effect of typing `C-g' at command level or to quit a user command would
  43. be unpredictable.  If you want to permit quitting inside a sentinel,
  44. bind `inhibit-quit' to `nil'.  *Note Quitting::.
  45.    All sentinels that do regexp searching or matching should save and
  46. restore the match data.  Otherwise, a sentinel that runs during a call
  47. to `sit-for' might clobber the match data of the program that called
  48. `sit-for'.  *Note Match Data::.
  49.  - Function: set-process-sentinel PROCESS SENTINEL
  50.      This function associates SENTINEL with PROCESS.  If SENTINEL is
  51.      `nil', then the process will have no sentinel.  The default
  52.      behavior when there is no sentinel is to insert a message in the
  53.      process's buffer when the process status changes.
  54.           (defun msg-me (process event)
  55.              (princ
  56.                (format "Process: %s had the event `%s'" process event)))
  57.           (set-process-sentinel (get-process "shell") 'msg-me)
  58.                => msg-me
  59.           (kill-process (get-process "shell"))
  60.                -| Process: #<process shell> had the event `killed'
  61.                => #<process shell>
  62.  - Function: process-sentinel PROCESS
  63.      This function returns the sentinel of PROCESS, or `nil' if it has
  64.      none.
  65.  - Function: waiting-for-user-input-p
  66.      While a sentinel or filter function is running, this function
  67.      returns non-`nil' if Emacs was waiting for keyboard input from the
  68.      user at the time the sentinel or filter function was called, `nil'
  69.      if it was not.
  70. File: elisp,  Node: Transaction Queues,  Next: TCP,  Prev: Sentinels,  Up: Processes
  71. Transaction Queues
  72. ==================
  73.    You can use a "transaction queue" for more convenient communication
  74. with subprocesses using transactions.  First use `tq-create' to create
  75. a transaction queue communicating with a specified process.  Then you
  76. can call `tq-enqueue' to send a transaction.
  77.  - Function: tq-create PROCESS
  78.      This function creates and returns a transaction queue
  79.      communicating with PROCESS.  The argument PROCESS should be a
  80.      subprocess capable of sending and receiving streams of bytes.  It
  81.      may be a child process, or it may be a TCP connection to a server
  82.      possibly on another machine.
  83.  - Function: tq-enqueue QUEUE QUESTION REGEXP CLOSURE FN
  84.      This function sends a transaction to queue QUEUE.  Specifying the
  85.      queue has the effect of specifying the subprocess to talk to.
  86.      The argument QUESTION is the outgoing message which starts the
  87.      transaction.  The argument FN is the function to call when the
  88.      corresponding answer comes back; it is called with two arguments:
  89.      CLOSURE, and the answer received.
  90.      The argument REGEXP is a regular expression to match the entire
  91.      answer; that's how `tq-enqueue' tells where the answer ends.
  92.      The return value of `tq-enqueue' itself is not meaningful.
  93.  - Function: tq-close QUEUE
  94.      Shut down transaction queue QUEUE, waiting for all pending
  95.      transactions to complete, and then terminate the connection or
  96.      child process.
  97.    Transaction queues are implemented by means of a filter function.
  98. *Note Filter Functions::.
  99. File: elisp,  Node: TCP,  Prev: Transaction Queues,  Up: Processes
  100.    Emacs Lisp programs can open TCP connections to other processes on
  101. the same machine or other machines.  A network connection is handled by
  102. Lisp much like a subprocess, and is represented by a process object.
  103. However, the process you are communicating with is not a child of the
  104. Emacs process, so you can't kill it or send it signals.  All you can do
  105. is send and receive data.  `delete-process' closes the connection, but
  106. does not kill the process at the other end; that process must decide
  107. what to do about closure of the connection.
  108.    You can distinguish process objects representing network connections
  109. from those representing subprocesses with the `process-status'
  110. function.  *Note Process Information::.
  111.  - Function: open-network-stream NAME BUFFER-OR-NAME HOST SERVICE
  112.      This function opens a TCP connection for a service to a host.  It
  113.      returns a process object to represent the connection.
  114.      The NAME argument specifies the name for the process object.  It
  115.      is modified as necessary to make it unique.
  116.      The BUFFER-OR-NAME argument is the buffer to associate with the
  117.      connection.  Output from the connection is inserted in the buffer,
  118.      unless you specify a filter function to handle the output.  If
  119.      BUFFER-OR-NAME is `nil', it means that the connection is not
  120.      associated with any buffer.
  121.      The arguments HOST and SERVICE specify where to connect to; HOST
  122.      is the host name (a string), and SERVICE is the name of a defined
  123.      network service (a string) or a port number (an integer).
  124. File: elisp,  Node: System Interface,  Next: Emacs Display,  Prev: Processes,  Up: Top
  125. Operating System Interface
  126. **************************
  127.    This chapter is about starting and getting out of Emacs, access to
  128. values in the operating system environment, and terminal input, output
  129. and flow control.
  130.    *Note Building Emacs::, for related information.  See also *Note
  131. Emacs Display::, for additional operating system status information
  132. pertaining to the terminal and the screen.
  133. * Menu:
  134. * Starting Up::         Customizing Emacs start-up processing.
  135. * Getting Out::         How exiting works (permanent or temporary).
  136. * System Environment::  Distinguish the name and kind of system.
  137. * User Identification:: Finding the name and user id of the user.
  138. * Time of Day::        Getting the current time.
  139. * Timers::        Setting a timer to call a function at a certain time.
  140. * Terminal Input::      Recording terminal input for debugging.
  141. * Terminal Output::     Recording terminal output for debugging.
  142. * Flow Control::        How to turn output flow control on or off.
  143. * Batch Mode::          Running Emacs without terminal interaction.
  144. File: elisp,  Node: Starting Up,  Next: Getting Out,  Up: System Interface
  145. Starting Up Emacs
  146. =================
  147.    This section describes what Emacs does when it is started, and how
  148. you can customize these actions.
  149. * Menu:
  150. * Start-up Summary::        Sequence of actions Emacs performs at start-up.
  151. * Init File::               Details on reading the init file (`.emacs').
  152. * Terminal-Specific::       How the terminal-specific Lisp file is read.
  153. * Command Line Arguments::  How command line arguments are processed,
  154.                               and how you can customize them.
  155. File: elisp,  Node: Start-up Summary,  Next: Init File,  Up: Starting Up
  156. Summary: Sequence of Actions at Start Up
  157. ----------------------------------------
  158.    The order of operations performed (in `startup.el') by Emacs when it
  159. is started up is as follows:
  160.   1. It runs the normal hook `before-init-hook'.
  161.   2. It loads `.emacs' unless `-q' was specified on command line.
  162.      (This is not done in `-batch' mode.)  `.emacs' is found in the
  163.      user's home directory; the `-u' option can specify the user name
  164.      whose home directory should be used.
  165.   3. It loads `default.el' unless `inhibit-default-init' is non-`nil'.
  166.      (This is not done in `-batch' mode or if `-q' was specified on
  167.      command line.)
  168.   4. It runs the normal hook `after-init-hook'.
  169.   5. It loads the terminal-specific Lisp file, if any, except when in
  170.      batch mode.
  171.   6. It runs `term-setup-hook'.
  172.   7. It runs `window-setup-hook'.  *Note Window Systems::.
  173.   8. It displays copyleft and nonwarranty, plus basic use information,
  174.      unless the value of the variable `inhibit-startup-message' is
  175.      non-`nil'.
  176.      This display is also inhibited in batch mode, and if the current
  177.      buffer is not `*scratch*'.
  178.   9. It processes any remaining command line arguments.
  179.  - User Option: inhibit-startup-message
  180.      This variable inhibits the initial startup messages (the
  181.      nonwarranty, etc.).  If it is non-`nil', then the messages are not
  182.      printed.
  183.      This variable exists so you can set it in your personal init file,
  184.      once you are familiar with the contents of the startup message.
  185.      Do not set this variable in the init file of a new user, or in a
  186.      way that affects more than one user, because that would prevent
  187.      new users from receiving the information they are supposed to see.
  188. File: elisp,  Node: Init File,  Next: Terminal-Specific,  Prev: Start-up Summary,  Up: Starting Up
  189. The Init File: `.emacs'
  190. -----------------------
  191.    When you start Emacs, it normally attempts to load the file `.emacs'
  192. from your home directory.  This file, if it exists, must contain Lisp
  193. code.  It is called your "init file".  The command line switches `-q'
  194. and `-u' can be used to control the use of the init file; `-q' says not
  195. to load an init file, and `-u' says to load a specified user's init
  196. file instead of yours.  *Note Entering Emacs: (emacs)Entering Emacs.
  197.    Emacs may also have a "default init file", which is the library
  198. named `default.el'.  Emacs finds the `default.el' file through the
  199. standard search path for libraries (*note How Programs Do Loading::.).
  200. The Emacs distribution does not have any such file; you may create one
  201. at your site for local customizations.  If the default init file
  202. exists, it is loaded whenever you start Emacs, except in batch mode or
  203. if `-q' is specified.  But your own personal init file, if any, is
  204. loaded first; if it sets `inhibit-default-init' to a non-`nil' value,
  205. then Emacs will not subsequently load the `default.el' file.
  206.    If there is a great deal of code in your `.emacs' file, you should
  207. move it into another file named `SOMETHING.el', byte-compile it (*note
  208. Byte Compilation::.), and make your `.emacs' file load the other file
  209. using `load' (*note Loading::.).
  210.    *Note Init File Examples: (emacs)Init File Examples, for examples of
  211. how to make various commonly desired customizations in your `.emacs'
  212. file.
  213.  - User Option: inhibit-default-init
  214.      This variable prevents Emacs from loading the default
  215.      initialization library file for your session of Emacs.  If its
  216.      value is non-`nil', then the default library is not loaded.  The
  217.      default value is `nil'.
  218.  - Variable: before-init-hook
  219.  - Variable: after-init-hook
  220.      These two normal hooks are run just before, and just after,
  221.      loading of the user's init file or `default.el'.
  222. File: elisp,  Node: Terminal-Specific,  Next: Command Line Arguments,  Prev: Init File,  Up: Starting Up
  223. Terminal-Specific Initialization
  224. --------------------------------
  225.    Each terminal type can have its own Lisp library that Emacs loads
  226. when run on that type of terminal.  For a terminal type named TERMTYPE,
  227. the library is called `term/TERMTYPE'.  Emacs finds the file by
  228. searching the `load-path' directories as it does for other files, and
  229. trying the `.elc' and `.el' suffixes.  Normally, terminal-specific Lisp
  230. library is located in `emacs/lisp/term', a subdirectory of the
  231. `emacs/lisp' directory in which most Emacs Lisp libraries are kept.
  232.    The library's name is constructed by concatenating the value of the
  233. variable `term-file-prefix' and the terminal type.  Normally,
  234. `term-file-prefix' has the value `"term/"'; changing this is not
  235. recommended.
  236.    The usual function of a terminal-specific library is to enable
  237. special keys to send sequences that Emacs can recognize.  It may also
  238. need to set or add to `function-key-map' if the Termcap entry does not
  239. fully explain what should go in it.  *Note Terminal Input::.
  240.    When the name of the terminal type contains a hyphen, only the part
  241. of the name before the first hyphen is significant in choosing the
  242. library name.  Thus, terminal types `aaa-48' and `aaa-30-rv' both use
  243. the `term/aaa' library.  If necessary, the library can evaluate
  244. `(getenv "TERM")' to find the full name of the terminal type.
  245.    Your `.emacs' file can prevent the loading of the terminal-specific
  246. library by setting the variable `term-file-prefix' to `nil'.  This
  247. feature is very useful when experimenting with your own peculiar
  248. customizations.
  249.    You can also arrange to override some of the actions of the
  250. terminal-specific library by setting the variable `term-setup-hook'.
  251. This is a normal hook which Emacs runs using `run-hooks' at the end of
  252. Emacs initialization, after loading both your `.emacs' file and any
  253. terminal-specific libraries.  You can use this variable to define
  254. initializations for terminals that do not have their own libraries.
  255. *Note Hooks::.
  256.  - Variable: term-file-prefix
  257.      If the `term-file-prefix' variable is non-`nil', Emacs loads a
  258.      terminal-specific initialization file as follows:
  259.           (load (concat term-file-prefix (getenv "TERM")))
  260.      You may set the `term-file-prefix' variable to `nil' in your
  261.      `.emacs' file if you do not wish to load the
  262.      terminal-initialization file.  To do this, put the following in
  263.      your `.emacs' file: `(setq term-file-prefix nil)'.
  264.  - Variable: term-setup-hook
  265.      This variable is a normal hook which Emacs runs after loading your
  266.      `.emacs' file, the default initialization file (if any) and after
  267.      loading terminal-specific Lisp files.  arguments.
  268.      You can use `term-setup-hook' to override the definitions made by
  269.      a terminal-specific file.
  270.    See `window-setup-hook' in *Note Window Systems::, for a related
  271. feature.
  272. File: elisp,  Node: Command Line Arguments,  Prev: Terminal-Specific,  Up: Starting Up
  273. Command Line Arguments
  274. ----------------------
  275.    You can use command line arguments to request various actions when
  276. you start Emacs.  Since you do not need to start Emacs more than once
  277. per day, and will often leave your Emacs session running longer than
  278. that, command line arguments are hardly ever used.  As a practical
  279. matter, it is best to avoid making the habit of using them, since this
  280. habit would encourage you to kill and restart Emacs unnecessarily
  281. often.  These options exist for two reasons: to be compatible with
  282. other editors (for invocation by other programs) and to enable shell
  283. scripts to run specific Lisp programs.
  284.  - Function: command-line
  285.      This function parses the command line which Emacs was called with,
  286.      processes it, loads the user's `.emacs' file and displays the
  287.      initial nonwarranty information, etc.
  288.  - Variable: command-line-processed
  289.      The value of this variable is `t' once the command line has been
  290.      processed.
  291.      If you redump Emacs by calling `dump-emacs', you may wish to set
  292.      this variable to `nil' first in order to cause the new dumped Emacs
  293.      to process its new command line arguments.
  294.  - Variable: command-switch-alist
  295.      The value of this variable is an alist of user-defined command-line
  296.      options and associated handler functions.  This variable exists so
  297.      you can add elements to it.
  298.      A "command line option" is an argument on the command line of the
  299.      form:
  300.           -OPTION
  301.      The elements of the `command-switch-alist' look like this:
  302.           (OPTION . HANDLER-FUNCTION)
  303.      The HANDLER-FUNCTION is called to handle OPTION and receives the
  304.      option name as its sole argument.
  305.      In some cases, the option is followed in the command line by an
  306.      argument.  In these cases, the HANDLER-FUNCTION can find all the
  307.      remaining command-line arguments in the variable
  308.      `command-line-args-left'.  (The entire list of command-line
  309.      arguments is in `command-line-args'.)
  310.      The command line arguments are parsed by the `command-line-1'
  311.      function in the `startup.el' file.  See also *Note Command Line
  312.      Switches and Arguments: (emacs)Command Switches.
  313.  - Variable: command-line-args
  314.      The value of this variable is the arguments passed by the shell to
  315.      Emacs, as a list of strings.
  316. File: elisp,  Node: Getting Out,  Next: System Environment,  Prev: Starting Up,  Up: System Interface
  317. Getting out of Emacs
  318. ====================
  319.    There are two ways to get out of Emacs: you can kill the Emacs job,
  320. which exits permanently, or you can suspend it, which permits you to
  321. reenter the Emacs process later.  As a practical matter, you seldom kill
  322. Emacs--only when you are about to log out.  Suspending is much more
  323. common.
  324. * Menu:
  325. * Killing Emacs::        Exiting Emacs irreversibly.
  326. * Suspending Emacs::     Exiting Emacs reversibly.
  327. File: elisp,  Node: Killing Emacs,  Next: Suspending Emacs,  Up: Getting Out
  328. Killing Emacs
  329. -------------
  330.    Killing Emacs means ending the execution of the Emacs process.  The
  331. parent process normally resumes control.
  332.    All the information in the Emacs process, aside from files that have
  333. been saved, is lost when the Emacs is killed.  Because killing Emacs
  334. inadvertently can lose a lot of work, Emacs queries for confirmation
  335. before actually terminating if you have buffers that need saving or
  336. subprocesses that are running.
  337.  - Function: kill-emacs &optional NO-QUERY
  338.      This function exits the Emacs process and kills it.
  339.      Normally, if there are modified files or if there are running
  340.      processes, `kill-emacs' asks the user for confirmation before
  341.      exiting.  However, if NO-QUERY is supplied and non-`nil', then
  342.      Emacs exits without confirmation.
  343.      If NO-QUERY is an integer, then it is used as the exit status of
  344.      the Emacs process.  (This is useful primarily in batch operation;
  345.      see *Note Batch Mode::.)
  346.      If NO-QUERY is a string, its contents are stuffed into the
  347.      terminal input buffer so that the shell (or whatever program next
  348.      reads input) can read them.
  349.  - Variable: kill-emacs-hook
  350.      This variable is a normal hook (a list of functions); the first
  351.      thing `kill-emacs' does is to run this hook with `run-hooks'.  That
  352.      calls each of the functions in the list, with no arguments.
  353. File: elisp,  Node: Suspending Emacs,  Prev: Killing Emacs,  Up: Getting Out
  354. Suspending Emacs
  355. ----------------
  356.    "Suspending Emacs" means stopping Emacs temporarily and returning
  357. control to its superior process, which is usually the shell.  This
  358. allows you to resume editing later in the same Emacs process, with the
  359. same buffers, the same kill ring, the same undo history, and so on.  To
  360. resume Emacs, use the appropriate command in the parent shell--most
  361. likely `fg'.
  362.    Some operating systems do not support suspension of jobs; on these
  363. systems, "suspension" actually creates a new shell temporarily as a
  364. subprocess of Emacs.  Then you would exit the shell to return to Emacs.
  365.    Suspension is not useful with window systems such as X, because the
  366. Emacs job may not have a parent that can resume it again, and in any
  367. case you can give input to some other job such as a shell merely by
  368. moving to a different window.  Therefore, suspending is not allowed
  369. when Emacs is an X client.
  370.  - Function: suspend-emacs STRING
  371.      This function stops Emacs and returns to the superior process.  It
  372.      returns `nil'.
  373.      If STRING is non-`nil', its characters are sent to be read as
  374.      terminal input by Emacs's superior shell.  The characters in
  375.      STRING are not echoed by the superior shell; only the results
  376.      appear.
  377.      Before suspending, `suspend-emacs' runs the normal hook
  378.      `suspend-hook'.  In Emacs version 18, `suspend-hook' was not a
  379.      normal hook; its value was a single function, and if its value was
  380.      non-`nil', then `suspend-emacs' returned immediately without
  381.      actually suspending anything.
  382.      After the user resumes Emacs, it runs the normal hook
  383.      `suspend-resume-hook' using `run-hooks'.  *Note Hooks::.
  384.      The next redisplay after resumption will redraw the entire screen,
  385.      unless the variable `no-redraw-on-reenter' is non-`nil' (*note
  386.      Refresh Screen::.).
  387.      In the following example, note that `pwd' is not echoed after
  388.      Emacs is suspended.  But it is read and executed by the shell.
  389.           (suspend-emacs)
  390.                => nil
  391.           
  392.           (add-hook 'suspend-hook
  393.                     (function (lambda ()
  394.                                 (or (y-or-n-p
  395.                                       "Really suspend? ")
  396.                                     (error "Suspend cancelled")))))
  397.                => (lambda nil
  398.                     (or (y-or-n-p "Really suspend? ")
  399.                         (error "Suspend cancelled")))
  400.           (add-hook 'suspend-resume-hook
  401.                     (function (lambda () (message "Resumed!"))))
  402.                => (lambda nil (message "Resumed!"))
  403.           (suspend-emacs "pwd")
  404.                => nil
  405.           ---------- Buffer: Minibuffer ----------
  406.           Really suspend? `y'
  407.           ---------- Buffer: Minibuffer ----------
  408.           
  409.           ---------- Parent Shell ----------
  410.           lewis@slug[23] % /user/lewis/manual
  411.           lewis@slug[24] % fg
  412.           
  413.           ---------- Echo Area ----------
  414.           Resumed!
  415.  - Variable: suspend-hook
  416.      This variable is a normal hook run before suspending.
  417.  - Variable: suspend-resume-hook
  418.      This variable is a normal hook run after suspending.
  419. File: elisp,  Node: System Environment,  Next: User Identification,  Prev: Getting Out,  Up: System Interface
  420. Operating System Environment
  421. ============================
  422.    Emacs provides access to variables in the operating system
  423. environment through various functions.  These variables include the
  424. name of the system, the user's UID, and so on.
  425.  - Variable: system-type
  426.      The value of this variable is a symbol indicating the type of
  427.      operating system Emacs is operating on.  Here is a table of the
  428.      symbols for the operating systems that Emacs can run on up to
  429.      version 19.1.
  430.     `aix-v3'
  431.           AIX version 3.
  432.     `berkeley-unix'
  433.           Berkeley BSD 4.1, 4.2, or 4.3.
  434.     `hpux'
  435.           Hewlett-Packard operating system, version 5, 6, or 7.
  436.     `irix'
  437.           Silicon Graphics Irix system.
  438.     `rtu'
  439.           RTU 3.0, UCB universe.
  440.     `unisoft-unix'
  441.           UniSoft's UniPlus 5.0 or 5.2.
  442.     `usg-unix-v'
  443.           AT&T's System V.0, System V Release 2.0, 2.2, or 3.
  444.     `vax-vms'
  445.           VAX VMS version 4 or 5.
  446.     `xenix'
  447.           SCO Xenix 386 Release 2.2.
  448.      We do not wish to add new symbols to make finer distinctions
  449.      unless it is absolutely necessary!  In fact, it would be nice to
  450.      eliminate some of these alternatives in the future.
  451.  - Function: system-name
  452.      This function returns the name of the machine you are running on.
  453.           (system-name)
  454.                => "prep.ai.mit.edu"
  455.  - Function: getenv VAR
  456.      This function returns the value of the environment variable VAR,
  457.      as a string.  If the variable `process-environment' specifies a
  458.      value for VAR, that overrides the actual environment.
  459.           (getenv "USER")
  460.                => "lewis"
  461.           
  462.           lewis@slug[10] % printenv
  463.           PATH=.:/user/lewis/bin:/usr/bin:/usr/local/bin
  464.           USER=lewis
  465.           TERM=ibmapa16
  466.           SHELL=/bin/csh
  467.           HOME=/user/lewis
  468.  - Command: setenv VARIABLE VALUE
  469.      This command sets the value of the environment variable named
  470.      VARIABLE to VALUE.  Both arguments should be strings.  This works
  471.      by modifying `process-environment'; binding that variable with
  472.      `let' is also reasonable practice.
  473.  - Variable: process-environment
  474.      This variable is a list of strings to append to the environment of
  475.      processes as they are created.  Each string assigns a value to a
  476.      shell environment variable.  (This applies both to asynchronous and
  477.      synchronous processes.)  The function `getenv' also looks at this
  478.      variable.
  479.           process-environment
  480.           => ("l=/usr/stanford/lib/gnuemacs/lisp"
  481.               "PATH=.:/user/lewis/bin:/usr/class:/nfsusr/local/bin"
  482.               "USER=lewis"
  483.           "TERM=ibmapa16"
  484.               "SHELL=/bin/csh"
  485.               "HOME=/user/lewis")
  486.  - Function: load-average
  487.      This function returns the current 1 minute, 5 minute and 15 minute
  488.      load averages in a list.  The values are integers that are 100
  489.      times the system load averages.  (The load averages indicate the
  490.      number of processes trying to run.)
  491.           (load-average)
  492.                => (169 48 36)
  493.           
  494.           lewis@rocky[5] % uptime
  495.            11:55am  up 1 day, 19:37,  3 users,
  496.            load average: 1.69, 0.48, 0.36
  497.  - Function: setprv PRIVILEGE-NAME &optional SETP GETPRV
  498.      This function sets or resets a VMS privilege.  (It does not exist
  499.      on Unix.)  The first arg is the privilege name, as a string.  The
  500.      second argument, SETP, is `t' or `nil', indicating whether the
  501.      privilege is to be turned on or off.  Its default is `nil'.  The
  502.      function returns `t' if success, `nil' if not.
  503.      If the third argument, GETPRV, is non-`nil', `setprv' does not
  504.      change the privilege, but returns `t' or `nil' indicating whether
  505.      the privilege is currently enabled.
  506. File: elisp,  Node: User Identification,  Next: Time of Day,  Prev: System Environment,  Up: System Interface
  507. User Identification
  508. ===================
  509.  - Function: user-login-name
  510.      This function returns the name under which the user is logged in.
  511.      This is based on the effective UID, not the real UID.
  512.           (user-login-name)
  513.                => "lewis"
  514.  - Function: user-real-login-name
  515.      This function returns the name under which the user logged in.
  516.      This is based on the real UID, not the effective UID.  This
  517.      differs from `user-login-name' only when running with the setuid
  518.      bit.
  519.  - Function: user-full-name
  520.      This function returns the full name of the user.
  521.           (user-full-name)
  522.                => "Bil Lewis"
  523.  - Function: user-real-uid
  524.      This function returns the real UID of the user.
  525.           (user-real-uid)
  526.                => 19
  527.  - Function: user-uid
  528.      This function returns the effective UID of the user.
  529. File: elisp,  Node: Time of Day,  Next: Timers,  Prev: User Identification,  Up: System Interface
  530. Time of Day
  531. ===========
  532.    This section explains how to determine the current time and the time
  533. zone.
  534.  - Function: current-time-string &optional TIME-VALUE
  535.      This function returns the current time and date as a
  536.      humanly-readable string.  The format of the string is unvarying;
  537.      the number of characters used for each part is always the same, so
  538.      you can reliably use `substring' to extract pieces of it.
  539.      However, it would be wise to count the characters from the
  540.      beginning of the string rather than from the end, as additional
  541.      information may be added at the end.
  542.      The argument TIME-VALUE, if given, specifies a time to format
  543.      instead of the current time.  The argument should be a cons cell
  544.      containing two integers, or a list whose first two elements are
  545.      integers.  Thus, you can use times obtained from `current-time'
  546.      (see below) and from `file-attributes' (*note File Attributes::.).
  547.           (current-time-string)
  548.                => "Wed Oct 14 22:21:05 1987"
  549.  - Function: current-time
  550.      This function returns the system's time value as a list of three
  551.      integers: `(HIGH LOW MICROSEC)'.  The integers HIGH and LOW
  552.      combine to give the number of seconds since 0:00 January 1, 1970,
  553.      which is HIGH * 2**16 + LOW.
  554.      The third element, MICROSEC, gives the microseconds since the
  555.      start of the current second (or 0 for systems that return time
  556.      only on the resolution of a second).
  557.      The first two elements can be compared with file time values such
  558.      as you get with the function `file-attributes'.  *Note File
  559.      Attributes::.
  560.  - Function: current-time-zone &optional TIME-VALUE
  561.      This function returns a list describing the time zone that the
  562.      user is in.
  563.      The value has the form `(OFFSET NAME)'.  Here OFFSET is an integer
  564.      giving the number of seconds ahead of UTC (east of Greenwich).  A
  565.      negative value means west of Greenwich.  The second element, NAME
  566.      is a string giving the name of the time zone.  Both elements
  567.      change when daylight savings time begins or ends; if the user has
  568.      specified a time zone that does not use a seasonal time
  569.      adjustment, then the value is constant through time.
  570.      If the operating system doesn't supply all the information
  571.      necessary to compute the value, both elements of the list are
  572.      `nil'.
  573.      The argument TIME-VALUE, if given, specifies a time to analyze
  574.      instead of the current time.  The argument should be a cons cell
  575.      containing two integers, or a list whose first two elements are
  576.      integers.  Thus, you can use times obtained from `current-time'
  577.      (see below) and from `file-attributes' (*note File Attributes::.).
  578. File: elisp,  Node: Timers,  Next: Terminal Input,  Prev: Time of Day,  Up: System Interface
  579. Timers
  580. ======
  581.    You can set up a timer to call a function at a specified future time.
  582.  - Function: run-at-time TIME REPEAT FUNCTION &rest ARGS
  583.      This function arranges to call FUNCTION with arguments ARGS at
  584.      time TIME.  The argument FUNCTION is a function to call later, and
  585.      ARGS are the arguments to give it when it is called.  The time
  586.      TIME is specified as a string.
  587.      Absolute times may be specified in a wide variety of formats; The
  588.      form `HOUR:MIN:SEC TIMEZONE MONTH/DAY/YEAR', where all fields are
  589.      numbers, works; the format that `current-time-string' returns is
  590.      also allowed.
  591.      To specify a relative time, use numbers followed by units.  For
  592.      example:
  593.     `1 min'
  594.           denotes 1 minute from now.
  595.     `1 min 5 sec'
  596.           denotes 65 seconds from now.
  597.     `1 min 2 sec 3 hour 4 day 5 week 6 fortnight 7 month 8 year'
  598.           denotes exactly 103 months, 123 days, and 10862 seconds from
  599.           now.
  600.      If TIME is an integer, that specifies a relative time measured in
  601.      seconds.
  602.      The argument REPEAT specifies how often to repeat the call.  If
  603.      REPEAT is `nil', there are no repetitions; FUNCTION is called just
  604.      once, at TIME.  If REPEAT is an integer, it specifies a repetition
  605.      period measured in seconds.
  606.  - Function: cancel-timer TIMER
  607.      Cancel the requested action for TIMER, which should be a value
  608.      previously returned by `run-at-time'.  This cancels the effect of
  609.      that call to `run-at-time'; the arrival of the specified time will
  610.      not cause anything special to happen.
  611. File: elisp,  Node: Terminal Input,  Next: Terminal Output,  Prev: Timers,  Up: System Interface
  612. Terminal Input
  613. ==============
  614.    This section describes functions and variables for recording or
  615. manipulating terminal input.  See *Note Emacs Display::, for related
  616. functions.
  617. * Menu:
  618. * Input Modes::        Options for how input is processed.
  619. * Translating Input::   Low level conversion of some characters or events
  620.               into others.
  621. * Recording Input::    Saving histories of recent or all input events.
  622. File: elisp,  Node: Input Modes,  Next: Translating Input,  Up: Terminal Input
  623. Input Modes
  624. -----------
  625.  - Function: set-input-mode INTERRUPT FLOW META QUIT-CHAR
  626.      This function sets the mode for reading keyboard input.  If
  627.      INTERRUPT is non-null, then Emacs uses input interrupts.  If it is
  628.      `nil', then it uses CBREAK mode.
  629.      If FLOW is non-`nil', then Emacs uses XON/XOFF (`C-q', `C-s') flow
  630.      control for output to terminal.  This has no effect except in
  631.      CBREAK mode.  *Note Flow Control::.
  632.      The normal setting is system dependent.  Some systems always use
  633.      CBREAK mode regardless of what is specified.
  634.      The argument META controls support for input character codes above
  635.      127.  If META is `t', Emacs converts characters with the 8th bit
  636.      set into Meta characters.  If META is `nil', Emacs disregards the
  637.      8th bit; this is necessary when the terminal uses it as a parity
  638.      bit.  If META is neither `t' nor `nil', Emacs uses all 8 bits of
  639.      input unchanged.  This is good for terminals using European 8-bit
  640.      character sets.
  641.      If QUIT-CHAR is non-`nil', it specifies the character to use for
  642.      quitting.  Normally this character is `C-g'.  *Note Quitting::.
  643.    The `current-input-mode' function returns the input mode settings
  644. Emacs is currently using.
  645.  - Function: current-input-mode
  646.      This function returns current mode for reading keyboard input.  It
  647.      returns a list, corresponding to the arguments of `set-input-mode',
  648.      of the form `(INTERRUPT FLOW META QUIT)' in which:
  649.     INTERRUPT
  650.           is non-`nil' when Emacs is using interrupt-driven input.  If
  651.           `nil', Emacs is using CBREAK mode.
  652.     FLOW
  653.           is non-`nil' if Emacs uses XON/XOFF (`C-q', `C-s') flow
  654.           control for output to the terminal.  This value has no effect
  655.           unless INTERRUPT is non-`nil'.
  656.     META
  657.           is non-`nil' if Emacs is paying attention to the eighth bit of
  658.           input characters; if nil, Emacs clears the eighth bit of
  659.           every input character.
  660.     QUIT
  661.           is the character Emacs currently uses for quitting, usually
  662.           `C-g'.
  663.  - Variable: meta-flag
  664.      This variable used to control whether to treat the 0200 bit in
  665.      keyboard input as the Meta bit.  `nil' meant no, and anything else
  666.      meant yes.  This variable existed in Emacs versions 18 and earlier
  667.      but no longer exists in Emacs 19; use `set-input-mode' instead.
  668. File: elisp,  Node: Translating Input,  Next: Recording Input,  Prev: Input Modes,  Up: Terminal Input
  669. Translating Input Events
  670. ------------------------
  671.  - Variable: extra-keyboard-modifiers
  672.      This variable lets Lisp programs "press" the modifier keys on the
  673.      keyboard.  The value is a bit mask:
  674.     1
  675.           The SHIFT key.
  676.     2
  677.           The LOCK key.
  678.     4
  679.           The CTL key.
  680.     8
  681.           The META key.
  682.      Each time the user types a keyboard key, it is altered as if the
  683.      modifier keys specified in the bit mask were held down.
  684.      When you use X windows, the program can "press" any of the modifier
  685.      keys in this way.  Otherwise, only the CTL and META keys can be
  686.      virtually pressed.
  687.  - Variable: keyboard-translate-table
  688.      This variable is the translate table for keyboard characters.  It
  689.      lets you reshuffle the keys on the keyboard without changing any
  690.      command bindings.  Its value must be a string or `nil'.
  691.      If `keyboard-translate-table' is a string, then each character read
  692.      from the keyboard is looked up in this string and the character in
  693.      the string is used instead.  If the string is of length N,
  694.      character codes N and up are untranslated.
  695.      In the example below, we set `keyboard-translate-table' to a
  696.      string of 128 characters.  Then we fill it in to swap the
  697.      characters `C-s' and `C-\' and the characters `C-q' and `C-^'.
  698.      Subsequently, typing `C-\' has all the usual effects of typing
  699.      `C-s', and vice versa.  (*Note Flow Control:: for more information
  700.      on this subject.)
  701.           (defun evade-flow-control ()
  702.             "Replace C-s with C-\ and C-q with C-^."
  703.             (interactive)
  704.             (let ((the-table (make-string 128 0)))
  705.               (let ((i 0))
  706.                 (while (< i 128)
  707.                   (aset the-table i i)
  708.                   (setq i (1+ i))))
  709.           
  710.               ;; Swap `C-s' and `C-\'.
  711.               (aset the-table ?\034 ?\^s)
  712.               (aset the-table ?\^s ?\034)
  713.               ;; Swap `C-q' and `C-^'.
  714.               (aset the-table ?\036 ?\^q)
  715.               (aset the-table ?\^q ?\036)
  716.           
  717.               (setq keyboard-translate-table the-table)))
  718.      Note that this translation is the first thing that happens to a
  719.      character after it is read from the terminal.  Record-keeping
  720.      features such as `recent-keys' and dribble files record the
  721.      characters after translation.
  722.  - Function: keyboard-translate FROM TO
  723.      This function modifies `keyboard-translate-table' to translate
  724.      character code FROM into character code TO.  It creates or
  725.      enlarges the translate table if necessary.
  726.  - Variable: function-key-map
  727.      This variable holds a keymap which describes the character
  728.      sequences sent by function keys on an ordinary character terminal.
  729.      This keymap uses the data structure as other keymaps, but is used
  730.      differently: it specifies translations to make while reading
  731.      events.
  732.      If `function-key-map' "binds" a key sequence K to a vector V, then
  733.      when K appears as a subsequence *anywhere* in a key sequence, it
  734.      is replaced with the events in V.
  735.      For example, VT100 terminals send `ESC O P' when the keypad PF1
  736.      key is pressed.  Therefore, we want Emacs to translate that
  737.      sequence of events into the single event `pf1'.  We accomplish
  738.      this by "binding" `ESC O P' to `[pf1]' in `function-key-map', when
  739.      using a VT100.
  740.      Thus, typing `C-c PF1' sends the character sequence `C-c ESC O P';
  741.      later the function `read-key-sequence' translates this back into
  742.      `C-c PF1', which it returns as the vector `[?\C-c pf1]'.
  743.      Entries in `function-key-map' are ignored if they conflict with
  744.      bindings made in the minor mode, local, or global keymaps.  The
  745.      intent is that the character sequences that function keys send
  746.      should not have command bindings in their own right.
  747.      The value of `function-key-map' is usually set up automatically
  748.      according to the terminal's Terminfo or Termcap entry, but
  749.      sometimes those need help from terminal-specific Lisp files.
  750.      Emacs comes with a number of terminal-specific files for many
  751.      common terminals; their main purpose is to make entries in
  752.      `function-key-map' beyond those that can be deduced from Termcap
  753.      and Terminfo.  *Note Terminal-Specific::.
  754.      Emacs versions 18 and earlier used totally different means of
  755.      detecting the character sequences that represent function keys.
  756.  - Variable: key-translation-map
  757.      This variable is another keymap used just like `function-key-map'
  758.      to translate input events into other events.  It differs from
  759.      `function-key-map' in two ways:
  760.         * `key-translation-map' goes to work after `function-key-map' is
  761.           finished; it receives the results of translation by
  762.           `function-key-map'.
  763.         * `key-translation-map' overrides actual key bindings.
  764.      The intent of `key-translation-map' is for users to map one
  765.      character set to another, including ordinary characters normally
  766.      bound to `self-insert-command'.
  767. File: elisp,  Node: Recording Input,  Prev: Translating Input,  Up: Terminal Input
  768. Recording Input
  769. ---------------
  770.  - Function: recent-keys
  771.      This function returns a vector containing the last 100 input events
  772.      from the keyboard or mouse.  All input events are included,
  773.      whether or not they were used as parts of key sequences.  Thus,
  774.      you always get the last 100 inputs, not counting keyboard macros.
  775.      (Events from keyboard macros are excluded because they are less
  776.      interesting for debugging; it should be enough to see the events
  777.      which invoked the macros.)
  778.  - Command: open-dribble-file FILENAME
  779.      This function opens a "dribble file" named FILENAME.  When a
  780.      dribble file is open, each input event from the keyboard or mouse
  781.      (but not those from keyboard macros) are written in that file.  A
  782.      non-character event is expressed using its printed representation
  783.      surrounded by `<...>'.
  784.      You close the dribble file by calling this function with an
  785.      argument of `nil'.  The function always returns `nil'.
  786.      This function is normally used to record the input necessary to
  787.      trigger an Emacs bug, for the sake of a bug report.
  788.           (open-dribble-file "~/dribble")
  789.                => nil
  790.    See also the `open-termscript' function (*note Terminal Output::.).
  791. File: elisp,  Node: Terminal Output,  Next: Flow Control,  Prev: Terminal Input,  Up: System Interface
  792. Terminal Output
  793. ===============
  794.    The terminal output functions send output to the terminal or keep
  795. track of output sent to the terminal.  The variable `baud-rate' tells
  796. you what Emacs thinks is the output speed of the terminal.
  797.  - Variable: baud-rate
  798.      This variable's value is the output speed of the terminal, as far
  799.      as Emacs knows.  Setting this variable does not change the speed
  800.      of actual data transmission, but the value is used for
  801.      calculations such as padding.  It also affects decisions about
  802.      whether to scroll part of the screen or repaint--even when using a
  803.      window system, (We designed it this way despite the fact that a
  804.      window system has no true "output speed", to give you a way to
  805.      tune these decisions.)
  806.      The value is measured in baud.
  807.    If you are running across a network, and different parts of the
  808. network work at different baud rates, the value returned by Emacs may be
  809. different from the value used by your local terminal.  Some network
  810. protocols communicate the local terminal speed to the remote machine, so
  811. that Emacs and other programs can get the proper value, but others do
  812. not.  If Emacs has the wrong value, it makes decisions that are less
  813. than optimal.  To fix the problem, set `baud-rate'.
  814.  - Function: baud-rate
  815.      This function returns the value of the variable `baud-rate'.  In
  816.      Emacs versions 18 and earlier, this was the only way to find out
  817.      the terminal speed.
  818.  - Function: send-string-to-terminal STRING
  819.      This function sends STRING to the terminal without alteration.
  820.      Control characters in STRING have terminal-dependent effects.
  821.      One use of this function is to define function keys on terminals
  822.      that have downloadable function key definitions.  For example,
  823.      this is how on certain terminals to define function key 4 to move
  824.      forward four characters (by transmitting the characters `C-u C-f'
  825.      to the computer):
  826.           (send-string-to-terminal "\eF4\^U\^F")
  827.                => nil
  828.  - Command: open-termscript FILENAME
  829.      This function is used to open a "termscript file" that will record
  830.      all the characters sent by Emacs to the terminal.  It returns
  831.      `nil'.  Termscript files are useful for investigating problems
  832.      where Emacs garbles the screen, problems which are due to incorrect
  833.      Termcap entries or to undesirable settings of terminal options more
  834.      often than actual Emacs bugs.  Once you are certain which
  835.      characters were actually output, you can determine reliably
  836.      whether they correspond to the Termcap specifications in use.
  837.      See also `open-dribble-file' in *Note Terminal Input::.
  838.           (open-termscript "../junk/termscript")
  839.                => nil
  840. File: elisp,  Node: Flow Control,  Next: Batch Mode,  Prev: Terminal Output,  Up: System Interface
  841. Flow Control
  842. ============
  843.    This section attempts to answer the question "Why does Emacs choose
  844. to use flow-control characters in its command character set?"  For a
  845. second view on this issue, read the comments on flow control in the
  846. `emacs/INSTALL' file from the distribution; for help with Termcap
  847. entries and DEC terminal concentrators, see `emacs/etc/TERMS'.
  848.    At one time, most terminals did not need flow control, and none used
  849. `C-s' and `C-q' for flow control.  Therefore, the choice of `C-s' and
  850. `C-q' as command characters was unobjectionable.  Emacs, for economy of
  851. keystrokes and portability, used nearly all the ASCII control
  852. characters, with mnemonic meanings when possible; thus, `C-s' for
  853. search and `C-q' for quote.
  854.    Later, some terminals were introduced which required these characters
  855. for flow control.  They were not very good terminals for full-screen
  856. editing, so Emacs maintainers did not pay attention.  In later years,
  857. flow control with `C-s' and `C-q' became widespread among terminals,
  858. but by this time it was usually an option.  And the majority of users,
  859. who can turn flow control off, were unwilling to switch to less
  860. mnemonic key bindings for the sake of flow control.
  861.    So which usage is "right", Emacs's or that of some terminal and
  862. concentrator manufacturers?  This is a rhetorical (or religious)
  863. question; it has no simple answer.
  864.    One reason why we are reluctant to cater to the problems caused by
  865. `C-s' and `C-q' is that they are gratuitous.  There are other
  866. techniques (albeit less common in practice) for flow control that
  867. preserve transparency of the character stream.  Note also that their use
  868. for flow control is not an official standard.  Interestingly, on the
  869. model 33 teletype with a paper tape punch (which is very old), `C-s'
  870. and `C-q' were sent by the computer to turn the punch on and off!
  871.    GNU Emacs version 19 provides a convenient way of enabling flow
  872. control if you want it: call the function `enable-flow-control'.
  873.  - Function: enable-flow-control
  874.      This function enables use of `C-s' and `C-q' for output flow
  875.      control, and provides the characters `C-\' and `C-^' as aliases
  876.      for them using `keyboard-translate-table' (*note Translating
  877.      Input::.).
  878.    You can use the function `enable-flow-control-on' in your `.emacs'
  879. file to enable flow control automatically on certain terminal types.
  880.  - Function: enable-flow-control-on &rest TERMTYPES
  881.      This function enables flow control, and the aliases `C-\' and
  882.      `C-^', if the terminal type is one of TERMTYPES.  For example:
  883.           (enable-flow-control-on "vt200" "vt300" "vt101" "vt131")
  884.    Here is how `enable-flow-control' does its job:
  885.   1. It sets CBREAK mode for terminal input, and tells the kernel to
  886.      handle flow control, with `(set-input-mode nil t)'.
  887.   2. It sets up `keyboard-translate-table' to translate `C-\' and `C-^'
  888.      into `C-s' and `C-q' were typed.  Except at its very lowest level,
  889.      Emacs never knows that the characters typed were anything but
  890.      `C-s' and `C-q', so you can in effect type them as `C-\' and `C-^'
  891.      even when they are input for other commands.  For example:
  892.           (setq keyboard-translate-table (make-string 128 0))
  893.           (let ((i 0))
  894.             ;; Map most characters into themselves.
  895.             (while (< i 128)
  896.               (aset keyboard-translate-table i i)
  897.               (setq i (1+ i))))
  898.             ;; Map `C-\' to `C-s'.
  899.             (aset the-table ?\034 ?\^s)
  900.             ;; Map `C-^' to `C-q'.
  901.             (aset the-table ?\036 ?\^q)))
  902.    If the terminal is the source of the flow control characters, then
  903. once you enable kernel flow control handling, you probably can make do
  904. with less padding than normal for that terminal.  You can reduce the
  905. amount of padding by customizing the Termcap entry.  You can also
  906. reduce it by setting `baud-rate' to a smaller value so that Emacs uses
  907. a smaller speed when calculating the padding needed.  *Note Terminal
  908. Output::.
  909. File: elisp,  Node: Batch Mode,  Prev: Flow Control,  Up: System Interface
  910. Batch Mode
  911. ==========
  912.    The command line option `-batch' causes Emacs to run
  913. noninteractively.  In this mode, Emacs does not read commands from the
  914. terminal, it does not alter the terminal modes, and it does not expect
  915. to be outputting to an erasable screen.  The idea is that you specify
  916. Lisp programs to run; when they are finished, Emacs should exit.  The
  917. way to specify the programs to run is with `-l FILE', which loads the
  918. library named FILE, and `-f FUNCTION', which calls FUNCTION with no
  919. arguments.
  920.    Any Lisp program output that would normally go to the echo area,
  921. either using `message' or using `prin1', etc., with `t' as the stream,
  922. goes instead to Emacs's standard output descriptor when in batch mode.
  923. Thus, Emacs behaves much like a noninteractive application program.
  924. (The echo area output that Emacs itself normally generates, such as
  925. command echoing, is suppressed entirely.)
  926.  - Variable: noninteractive
  927.      This variable is non-`nil' when Emacs is running in batch mode.
  928.